DescribeScalingInstances

Description

Query the list of ECS instances in the scaling group. When querying, you can specify the scaling group ID, scaling configuration ID, health status, lifecycle status, and creation type to filter.

Request Method

POST

Request Path

/apsara/route/Ess/DescribeScalingInstances

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
PageSize	BODY	integer	No	No sample value for this parameter.	the number of rows per page set during paging query, the maximum value is 50 rows, and the default value is 10.
PageNumber	BODY	integer	No	No sample value for this parameter.	the page number of the ECS instance list, starting with 1 and default with 1.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
ScalingGroupId	BODY	string	No	No sample value for this parameter.	ID of the scaling group.
HealthStatus	BODY	string	No	No sample value for this parameter.	The health status of the ECS instance in scaling. Optional value: Healthy: healthy ECS instance. Unhealthy: unhealthy ECS instance.
LifecycleState	BODY	string	No	No sample value for this parameter.	The lifecycle status of the ECS instance in the scaling group. Optional value: InService: the scaling group has been successfully joined and is running normally. Pending: joining the scaling group but not yet completing the relevant configuration. Removing: moving out of the scaling group.
RegionId	BODY	string	Yes	No sample value for this parameter.	the region ID to which the scaling group belongs.
ScalingConfigurationId	BODY	string	No	No sample value for this parameter.	the associated scaling configuration ID.
CreationType	BODY	string	No	No sample value for this parameter.	the creation type of the ECS instance. Optional value: AutoCreated: automatically created by auto scaling in the scaling group. Attached: created outside of auto scaling and manually added to the scaling group.
version	BODY	string	No	2016-01-01	version of api
InstanceId.N	BODY	string	No	No sample value for this parameter.	the ID of the ECS instance. You can enter up to 20. When returning query results, invalid InstanceId are ignored and no error is reported.

Return data

Name	Type	Sample value	Description
RequestID	string	1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC	Request id

Example

Successful Response example

{
 "RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}